<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements.  See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache License, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License.  You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> *      http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the License for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the License.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>package org.apache.commons.net.telnet;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * The TelnetCommand class cannot be instantiated and only serves as a<a name="line.21"></a>
<span class="sourceLineNo">022</span> * storehouse for telnet command constants.<a name="line.22"></a>
<span class="sourceLineNo">023</span> * @see org.apache.commons.net.telnet.Telnet<a name="line.23"></a>
<span class="sourceLineNo">024</span> * @see org.apache.commons.net.telnet.TelnetClient<a name="line.24"></a>
<span class="sourceLineNo">025</span> */<a name="line.25"></a>
<span class="sourceLineNo">026</span><a name="line.26"></a>
<span class="sourceLineNo">027</span>public final class TelnetCommand<a name="line.27"></a>
<span class="sourceLineNo">028</span>{<a name="line.28"></a>
<span class="sourceLineNo">029</span>    /*** The maximum value a command code can have.  This value is 255. ***/<a name="line.29"></a>
<span class="sourceLineNo">030</span>    public static final int MAX_COMMAND_VALUE = 255;<a name="line.30"></a>
<span class="sourceLineNo">031</span><a name="line.31"></a>
<span class="sourceLineNo">032</span>    /*** Interpret As Command code.  Value is 255 according to RFC 854. ***/<a name="line.32"></a>
<span class="sourceLineNo">033</span>    public static final int IAC = 255;<a name="line.33"></a>
<span class="sourceLineNo">034</span><a name="line.34"></a>
<span class="sourceLineNo">035</span>    /*** Don't use option code.  Value is 254 according to RFC 854. ***/<a name="line.35"></a>
<span class="sourceLineNo">036</span>    public static final int DONT = 254;<a name="line.36"></a>
<span class="sourceLineNo">037</span><a name="line.37"></a>
<span class="sourceLineNo">038</span>    /*** Request to use option code.  Value is 253 according to RFC 854. ***/<a name="line.38"></a>
<span class="sourceLineNo">039</span>    public static final int DO = 253;<a name="line.39"></a>
<span class="sourceLineNo">040</span><a name="line.40"></a>
<span class="sourceLineNo">041</span>    /*** Refuse to use option code.  Value is 252 according to RFC 854. ***/<a name="line.41"></a>
<span class="sourceLineNo">042</span>    public static final int WONT = 252;<a name="line.42"></a>
<span class="sourceLineNo">043</span><a name="line.43"></a>
<span class="sourceLineNo">044</span>    /*** Agree to use option code.  Value is 251 according to RFC 854. ***/<a name="line.44"></a>
<span class="sourceLineNo">045</span>    public static final int WILL = 251;<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span>    /*** Start subnegotiation code.  Value is 250 according to RFC 854. ***/<a name="line.47"></a>
<span class="sourceLineNo">048</span>    public static final int SB = 250;<a name="line.48"></a>
<span class="sourceLineNo">049</span><a name="line.49"></a>
<span class="sourceLineNo">050</span>    /*** Go Ahead code.  Value is 249 according to RFC 854. ***/<a name="line.50"></a>
<span class="sourceLineNo">051</span>    public static final int GA = 249;<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span>    /*** Erase Line code.  Value is 248 according to RFC 854. ***/<a name="line.53"></a>
<span class="sourceLineNo">054</span>    public static final int EL = 248;<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span>    /*** Erase Character code.  Value is 247 according to RFC 854. ***/<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public static final int EC = 247;<a name="line.57"></a>
<span class="sourceLineNo">058</span><a name="line.58"></a>
<span class="sourceLineNo">059</span>    /*** Are You There code.  Value is 246 according to RFC 854. ***/<a name="line.59"></a>
<span class="sourceLineNo">060</span>    public static final int AYT = 246;<a name="line.60"></a>
<span class="sourceLineNo">061</span><a name="line.61"></a>
<span class="sourceLineNo">062</span>    /*** Abort Output code.  Value is 245 according to RFC 854. ***/<a name="line.62"></a>
<span class="sourceLineNo">063</span>    public static final int AO = 245;<a name="line.63"></a>
<span class="sourceLineNo">064</span><a name="line.64"></a>
<span class="sourceLineNo">065</span>    /*** Interrupt Process code.  Value is 244 according to RFC 854. ***/<a name="line.65"></a>
<span class="sourceLineNo">066</span>    public static final int IP = 244;<a name="line.66"></a>
<span class="sourceLineNo">067</span><a name="line.67"></a>
<span class="sourceLineNo">068</span>    /*** Break code.  Value is 243 according to RFC 854. ***/<a name="line.68"></a>
<span class="sourceLineNo">069</span>    public static final int BREAK = 243;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span>    /*** Data mark code.  Value is 242 according to RFC 854. ***/<a name="line.71"></a>
<span class="sourceLineNo">072</span>    public static final int DM = 242;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span>    /*** No Operation code.  Value is 241 according to RFC 854. ***/<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public static final int NOP = 241;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>    /*** End subnegotiation code.  Value is 240 according to RFC 854. ***/<a name="line.77"></a>
<span class="sourceLineNo">078</span>    public static final int SE = 240;<a name="line.78"></a>
<span class="sourceLineNo">079</span><a name="line.79"></a>
<span class="sourceLineNo">080</span>    /*** End of record code.  Value is 239. ***/<a name="line.80"></a>
<span class="sourceLineNo">081</span>    public static final int EOR = 239;<a name="line.81"></a>
<span class="sourceLineNo">082</span><a name="line.82"></a>
<span class="sourceLineNo">083</span>    /*** Abort code.  Value is 238. ***/<a name="line.83"></a>
<span class="sourceLineNo">084</span>    public static final int ABORT = 238;<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span>    /*** Suspend process code.  Value is 237. ***/<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public static final int SUSP = 237;<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span>    /*** End of file code.  Value is 236. ***/<a name="line.89"></a>
<span class="sourceLineNo">090</span>    public static final int EOF = 236;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span>    /*** Synchronize code.  Value is 242. ***/<a name="line.92"></a>
<span class="sourceLineNo">093</span>    public static final int SYNCH = 242;<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>    /*** String representations of commands. ***/<a name="line.95"></a>
<span class="sourceLineNo">096</span>    private static final String __commandString[] = {<a name="line.96"></a>
<span class="sourceLineNo">097</span>                "IAC", "DONT", "DO", "WONT", "WILL", "SB", "GA", "EL", "EC", "AYT",<a name="line.97"></a>
<span class="sourceLineNo">098</span>                "AO", "IP", "BRK", "DMARK", "NOP", "SE", "EOR", "ABORT", "SUSP", "EOF"<a name="line.98"></a>
<span class="sourceLineNo">099</span>            };<a name="line.99"></a>
<span class="sourceLineNo">100</span><a name="line.100"></a>
<span class="sourceLineNo">101</span>    private static final int __FIRST_COMMAND = IAC;<a name="line.101"></a>
<span class="sourceLineNo">102</span>    private static final int __LAST_COMMAND = EOF;<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span>    /***<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * Returns the string representation of the telnet protocol command<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * corresponding to the given command code.<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * &lt;p&gt;<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @param code The command code of the telnet protocol command.<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @return The string representation of the telnet protocol command.<a name="line.109"></a>
<span class="sourceLineNo">110</span>     ***/<a name="line.110"></a>
<span class="sourceLineNo">111</span>    public static final String getCommand(int code)<a name="line.111"></a>
<span class="sourceLineNo">112</span>    {<a name="line.112"></a>
<span class="sourceLineNo">113</span>        return __commandString[__FIRST_COMMAND - code];<a name="line.113"></a>
<span class="sourceLineNo">114</span>    }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span>    /***<a name="line.116"></a>
<span class="sourceLineNo">117</span>     * Determines if a given command code is valid.  Returns true if valid,<a name="line.117"></a>
<span class="sourceLineNo">118</span>     * false if not.<a name="line.118"></a>
<span class="sourceLineNo">119</span>     * &lt;p&gt;<a name="line.119"></a>
<span class="sourceLineNo">120</span>     * @param code  The command code to test.<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * @return True if the command code is valid, false if not.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     **/<a name="line.122"></a>
<span class="sourceLineNo">123</span>    public static final boolean isValidCommand(int code)<a name="line.123"></a>
<span class="sourceLineNo">124</span>    {<a name="line.124"></a>
<span class="sourceLineNo">125</span>        return (code &lt;= __FIRST_COMMAND &amp;&amp; code &gt;= __LAST_COMMAND);<a name="line.125"></a>
<span class="sourceLineNo">126</span>    }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span>    // Cannot be instantiated<a name="line.128"></a>
<span class="sourceLineNo">129</span>    private TelnetCommand()<a name="line.129"></a>
<span class="sourceLineNo">130</span>    { }<a name="line.130"></a>
<span class="sourceLineNo">131</span>}<a name="line.131"></a>




























































</pre>
</div>
</body>
</html>
